docs(updates): add ADR discussing automatic versioning - #12

/fs quality

QualityFlow Pipeline Summary

Test Output

Jira: ADR-0043

Generated by QualityFlow

🤖 Finished Review · ✅ Success · Started 2:47 PM UTC · Completed 3:01 PM UTC
Commit: 4365b3d · View workflow run →

Review

Findings

Medium

• [technical accuracy] docs/plans/automatic-updates.md:46 — The design doc references the template file internal/scaffold/fullsend-repo/templates/shim-per-repo.yaml but this file does not exist in the repository. The actual template file in that directory is internal/scaffold/fullsend-repo/templates/shim-workflow-call.yaml. If the implementation relies on finding and modifying the file at the stated path, it will fail.
  Remediation: Update the file path to reference the correct template file(s).

Low

• [technical accuracy] docs/plans/automatic-updates.md:27 — Typo: vMAJOR.MINOR.PACTH should be vMAJOR.MINOR.PATCH.
• [technical accuracy] docs/plans/automatic-updates.md:18 — The document states GH Actions use the relative path uses: ./.defaults/.github/actions/validate-enrollment, but in the current scaffold workflows the actual path is uses: ./.github/actions/validate-enrollment (no .defaults prefix).
• [internal consistency] docs/plans/automatic-updates.md:14 — The document says 'the action.yml YAML in the root of the repository' but there is no action.yml at the repo root. The actual file is internal/scaffold/fullsend-repo/.github/actions/fullsend/action.yml.
• [design document alignment] docs/plans/automatic-updates.md:39 — The design proposes using a single __FULLSEND_REF__ for all three components (workflows, actions, CLI). Git refs like main may not resolve to valid CLI binary versions since the download mechanism constructs URLs from semver strings.
• [frontmatter-consistency] docs/ADRs/0043-automatic-updates.md:1 — The relates_to field is empty ([]) but all other ADRs populate this field. The ADR references infrastructure covered by ADR-0031 and ADR-0033.
• [adr-template-compliance] docs/ADRs/0043-automatic-updates.md:17 — The inline HTML comment uses different text than the template in 0000-adr-template.md.
• [section-naming-convention] docs/ADRs/0043-automatic-updates.md:25 — The ADR omits the optional 'Options' section. 19 of 25 existing ADRs include it.
• [content-structure] docs/plans/automatic-updates.md:1 — The 'Design Document:' prefix in the title is unique to this file. Other plans use bare topic names.
• [heading-hierarchy] docs/plans/automatic-updates.md:114 — 'Some Future Problems' uses informal tone. Consider '## Future Considerations' or '## Open Questions'.
• [numbering-gap] docs/ADRs/0043-automatic-updates.md — ADR numbering jumps from 0036 to 0043. Intentional for upstream mirroring, but the strategy is not documented.
• [implementation-gap] docs/plans/automatic-updates.md:45 — ADR status is 'Accepted' but no code changes are present. If mirrored from upstream where it was accepted, consider noting this context.
• [stale-parameter-reference] .github/workflows/fullsend.yaml:49 — Workflow uses fullsend_ai_ref which the design doc proposes renaming to fullsend_actions_ref. Not stale yet, but will need updating when implementation lands.
• [stale-version-tag] .github/workflows/fullsend.yaml:43 — Workflow references @v0 which ADR-0043 proposes migrating. Will need updating when implementation lands.

Info

• [edge case correctness] docs/ADRs/0043-automatic-updates.md:56 — The ADR says current users will track the new floating tag automatically, but v0 is hard-coded in workflow files. The migration mechanism is not described.
• [variable-naming-consistency] docs/plans/automatic-updates.md:66 — Proposed renames use 'actions' (full word) vs 'cli' (abbreviation). Minor inconsistency but 'CLI' is a universally understood term.
• [design-evolution] docs/plans/automatic-updates.md:27 — The 'current state' description may reflect upstream state rather than this fork's state.

Closing — QF infrastructure updated on main, will re-create with improved pipeline.